cs-membership-user-migration icon

cs-membership-user-migration

1.0.x
(0 reviews)

📘 Documentación de la API - CS Membership User Migration

Este Diccionario de API proporciona una descripción general completa de los componentes clave utilizados en la API de Migración de Usuarios de CS Membership.

🗂️ Información Base

🔐 Métodos de Autenticación

  1. Aplicación de Client IDRequiere un encabezado client_id válido para las solicitudes de la API.
  2. OAuth 2.0Autenticación segura basada en tokens usando tokens Bearer en el encabezado Authorization.Ejemplo de Encabezados de Autenticación:
    -H "client_id: TU_CLIENT_ID" \
-H "Authorization: Bearer TU_TOKEN_DE_ACCESO"

📍 Resumen de Endpoints

1️⃣ GET /obtain-users-by-b2c

  • Descripción: Recuperar información de usuario basada en el identificador B2C.
  • Método: GET
  • Ruta: /obtain-users-by-b2c
  • Parámetro de Consulta:
    • sub (string, requerido) - El identificador único de usuario B2C.
      Ejemplo de Solicitud:
      curl -X GET "https://cs-membership-user-migration-dev.us-e1.cloudhub.io/api/obtain-users-by-b2c?sub=4fbcdd2e-c284-4aa1-9320-ab72a21d4aaf" \
-H "Content-Type: application/json" \
-H "client_id: TU_CLIENT_ID" \
-H "Authorization: Bearer TU_TOKEN_DE_ACCESO"
      Ejemplo de Respuesta:
      {
"id": "4fbcdd2e-c284-4aa1-9320-ab72a21d4aaf",
"name": "John Doe",
"email": "john.doe@example.com",
"status": "active"
}

🗃️ Parámetros de Consulta

  • sub (requerido): El identificador B2C del usuario (formato UUID).
    • Ejemplo: 4fbcdd2e-c284-4aa1-9320-ab72a21d4aaf

📦 Campos de Respuesta

  • id (string): El identificador único del usuario.
  • name (string): Nombre completo del usuario.
  • email (string): Dirección de correo electrónico del usuario.
  • status (string): Estado actual del usuario (ej., active, inactive).

⚠️ Manejo de Errores

La API maneja errores utilizando códigos de estado HTTP estándar y respuestas de error estructuradas.

Ejemplo de Respuesta de Error:

{
  "error": "invalid_request",
  "error_description": "Missing required parameter: sub"
}

Códigos de Estado HTTP Comunes:

  • 200 OK - La solicitud fue exitosa.
  • 400 Bad Request - Parámetros inválidos o faltantes.
  • 401 Unauthorized - Falla en la autenticación.
  • 404 Not Found - Recurso no encontrado.
  • 500 Internal Server Error - Error inesperado del servidor.

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

  • Documentación actualizada por última vez: Agosto 2025
  • Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en Agosto 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API CS Membership User Migration

Reviews